(BEDS-295) implement automated api doc generation #748
+200
−26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
remoterami
approved these changes
Aug 22, 2024
backend/pkg/api/handlers/public.go
Outdated
Comment on lines
117
to
128
| // PublicPostValidatorDashboards godoc | ||
| // | ||
| // @Description Create a new validator dashboard. **Note**: New dashboards will automatically have a default group created. | ||
| // @Security ApiKeyInHeader || ApiKeyInQuery | ||
| // @Tags Validator Dashboards | ||
| // @Accept json | ||
| // @Produce json | ||
| // @Param request body handlers.PublicPostValidatorDashboards.request true "`name`: Specify the name of the dashboard.<br>`network`: Specify the network for the dashboard. Possible options are:<ul><li>`ethereum`</li><li>`gnosis`</li></ul>" | ||
| // @Success 201 {object} types.PostValidatorDashboardsResponse | ||
| // @Failure 400 {object} types.ApiErrorResponse | ||
| // @Failure 409 {object} types.ApiErrorResponse "Conflict. The request could not be performed by the server because the authenticated user has already reached their dashboard limit." | ||
| // @Router /validator-dashboards [post] |
There was a problem hiding this comment.
Would be cool if there was a way to even generate stubs of these. Like at least the route, return objects etc.
There was a problem hiding this comment.
best we can get is prob copilot auto completion 🤷
Deploying beaconchain with
|
| Latest commit: |
30335c5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b807fccc.beaconchain.pages.dev |
| Branch Preview URL: | https://beds-295-api-docs.beaconchain.pages.dev |
# Conflicts: # backend/pkg/api/handlers/public.go
# Conflicts: # backend/pkg/api/handlers/public.go
# Conflicts: # backend/cmd/main.go # backend/go.mod
peterbitfly
approved these changes
Sep 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.